diskSpace

Type

function

Summary

Returns the amount of free space on the disk that holds the defaultFolder.

Syntax

the diskSpace

diskSpace()

Description

Use the diskSpace function to determine whether there is enough free space to complete an action (such as downloading data).

The value returned by the diskSpace function is in bytes. To convert to kilobytes (K), divide the return value by 1024. To convert to megabytes (M), divide by 1024^2. To convert to gigabytes (G), divide by 1024^3:

    function humanReadableDiskSpace theUnits
        set the caseSensitive to false
        switch char 1 of theUnits
            case \"k\"
    	        return the diskSpace div 1024
    	        break
            case \"m\"
                return the diskSpace div (1024^2)
                break
            case \"g\"
                return the diskSpace div (1024^3)
                break
            default
                return the diskSpace
                break
        end switch
    end humanReadableDiskSpace

Examples

the diskSpace

put the diskSpace div (1024^2) into megabytesAvailable

if the diskSpace < spaceNeeded then exit mouseUp

Value

Name	Type	Description
return		The diskSpace function returns an integer.

Related

function: hasMemory, volumes, stackSpace

glossary: download, return value, return, byte

keyword: integer

property: freeSize, size, defaultFolder

control structure: function

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

windows

linux

Platforms

desktop

server